<!--

    Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.
    Portions Copyright &#169; [2017-2020] Payara Foundation and/or affiliates.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->

<p><a id="ref-jmsservice" name="ref-jmsservice"></a><a id="GHJMS00010" name="GHJMS00010"></a></p>

<h4><a id="sthref74" name="sthref74"></a>Java Message Service</h4>
<a name="BEGIN" id="BEGIN"></a>
<p>Use the Java Message Service page to configure settings to be used by the default JMS provider, Payara Server Message Queue.</p>
<p>The Java Message Service page contains the following options.</p>
<dl>
<dt>Load Defaults</dt>
<dd>
<p>Button to restore settings that have default values to their default values. Settings that do not have default values are not changed.</p>
</dd>
<dt>Ping</dt>
<dd>
<p>Button to verify that the JMS service is running on the default JMS host. If the JMS service is up and running, a message reports that the ping succeeded.</p>
</dd>
<dt>Configuration Name</dt>
<dd>
<p>The name of the configuration to which the settings on this page apply. This field is read only.</p>
</dd>
<dt>Type</dt>
<dd>
<p>The type of access for the JMS service. Available choices are:</p>
<dl>
<dt>EMBEDDED</dt>
<dd>
<p>Access the JMS service on the local host. The JMS service is started in the same JVM machine as Payara Server. Lazy initialization starts the default embedded broker on the first access of JMS services rather than at Payara Server startup. This is the default type of JMS Service.</p>
</dd>
<dt>LOCAL</dt>
<dd>
<p>Access the JMS service on the local host. The JMS provider is started along with the Payara Server.</p>
</dd>
<dt>REMOTE</dt>
<dd>
<p>Access the JMS service on another system. If you choose REMOTE, the JMS service is not started by Payara Server the next time the server starts. Instead, the JMS service is started and managed by Message Queue, so you must start the Message Queue broker separately. If you choose this value and are using a remote host, follow the instructions in <a href="task-jmshostedit.html">To Edit a JMS Host</a> to specify the name of the remote host.</p>
</dd>
</dl>
</dd>
<dt>Startup Timeout</dt>
<dd>
<p>The number of seconds Payara Server waits for the JMS service to start before aborting the startup. On a slow or overloaded system, increase the value from the default. The default value is 60.</p>
</dd>
<dt>Start Arguments</dt>
<dd>
<p>Arguments to customize the JMS service startup. Use any arguments available through the <i>as-install-parent</i><code>/mq/bin/imqbrokerd</code> command.</p>
</dd>
<dt>Reconnect</dt>
<dd>
<p>If the Reconnect Enabled checkbox is selected, the JMS service attempts to reconnect to a message server (or the list of addresses in the AddressList) when a connection is lost. This option is enabled by default.</p>
</dd>
<dt>Reconnect Interval</dt>
<dd>
<p>The number of seconds between reconnect attempts. This interval applies for attempts on each address in the AddressList and for successive addresses in the list. If it is too short, this time interval does not give a broker time to recover. If it is too long, the reconnect might represent an unacceptable delay. The default value is 5 seconds.</p>
</dd>
<dt>Reconnect Attempts</dt>
<dd>
<p>The number of attempts to connect (or reconnect) for each address in the AddressList before the client runtime tries the next address in the list. A value of -1 indicates that the number of reconnect attempts is unlimited (the client runtime attempts to connect to the first address until it succeeds). The default value is 3.</p>
</dd>
<dt>Default JMS Host</dt>
<dd>
<p>The name of the default JMS host. The default value is <code>default_JMS_host</code>.</p>
</dd>
<dt>Master Broker</dt>
<dd>
<p>The name of the Payara Server clustered instance whose associated Message Queue broker is to be used as the master broker in the Message Queue broker cluster. Leave this field blank to enable Payara Server to designate a master broker automatically.</p>
<p>If you change this value, you must restart the Payara Server cluster that uses the configuration.</p>
</dd>
<dt>Address List Behavior</dt>
<dd>
<p>The order of connection attempts. Available choices are:</p>
<dl>
<dt><code>random</code></dt>
<dd>
<p>Select an address from the AddressList randomly. If there are many clients attempting a connection using the same connection factory, specify <code>random</code> to prevent them from all being connected to the same address. This option is the default.</p>
</dd>
<dt><code>priority</code></dt>
<dd>
<p>The reconnect always tries to connect to the first server address in the AddressList and uses another one only if the first broker is not available.</p>
</dd>
</dl>
</dd>
<dt>Address List Iterations</dt>
<dd>
<p>The number of times the JMS service iterates through the AddressList in an effort to establish (or reestablish) a connection. A value of -1 indicates that the number of attempts is unlimited. The default value is 3. The maximum value is 2147483647.</p>
</dd>
<dt>MQ Scheme and MQ Service</dt>
<dd>
<p>The Message Queue address scheme name and the Message Queue connection service name if a non-default scheme or service is to be used. See <a href="ref-mqschemeservice.html">MQ Scheme and MQ Service Address Syntax</a> for syntax information.</p>
</dd>
<dt>Additional Properties</dt>
<dd>
<p>Additional properties for the JMS Service.</p>
</dd>
</dl>
<a id="sthref75" name="sthref75"></a>
<h5>Related Tasks</h5>
<ul>
<li>
<p><a href="task-jmsservice.html">To Configure the JMS Service</a></p>
</li>
<li>
<p><a href="task-jmshostnew.html">To Create a JMS Host</a></p>
</li>
<li>
<p><a href="task-jmshostedit.html">To Edit a JMS Host</a></p>
</li>
<li>
<p><a href="task-jmshostdelete.html">To Delete a JMS Host</a></p>
</li>
</ul>
<a id="sthref76" name="sthref76"></a>
<h5>Related asadmin Commands</h5>
<p><a href="/resource/reference/en/help/reference/jms-ping"><code>jms-ping</code>(1)</a></p>


<small>Copyright &#169; 2005, 2017, Oracle and/or its affiliates. All rights reserved. <a href="docinfo.html">Legal Notices</a></small>
<small>Portions Copyright &#169; [2017-2020] Payara Foundation and/or affiliates.</small>
